<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>OSAL_MUTEX_Lock Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00657.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00626.html" target="topic">OSAL Library Help</a> &gt; <a href="00635.html" target="topic">Library Interface</a> &gt; b) Mutex Functions &gt; <a href="00657.html" target="topic">OSAL_MUTEX_Lock Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00656.html" target="topic">Previous</a> | <a href="00635.html" target="topic">Up</a> | <a href="00658.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: OSAL_MUTEX_Lock@OSAL_MUTEX_HANDLE_TYPE*@uint16_t Topic Title: OSAL_MUTEX_Lock Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
OSAL_MUTEX_Lock Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This function locks a mutex, waiting for the specified time-out. If it cannot be obtained or the time-out period elapses 'false' is returned.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><a href="00660.html" target="topic">OSAL_RESULT</a> <strong><span style="color: #000000">OSAL_MUTEX_Lock</span></strong>(
    OSAL_MUTEX_HANDLE_TYPE* <strong><span style="color: #000000">mutexID</span></strong>, 
    uint16_t <strong><span style="color: #000000">waitMS</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
Mutex must have been created.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
mutexID&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Pointer to the mutex handle<br>&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
waitMS&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Time-out value in milliseconds:&nbsp;</p>
<ul class="Element630">
<li class="Element600">0, do not wait return immediately</li>
<li class="Element600">OSAL_WAIT_FOREVER, wait until mutex is obtained before returning</li>
<li class="Element600">Other values, time-out delay</li>
</ul><p class="Element307">
&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">

<ul class="Element630">
<li class="Element600">OSAL_RESULT_TRUE - Mutex successfully obtained</li>
<li class="Element600">OSAL_RESULT_FALSE - Mutex failed to be obtained or time-out occurred</li>
</ul></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
None.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12">
...
 <strong><span style="color: #000080">if</span></strong> (OSAL_MUTEX_Lock(&amp;mutexData, 1000) == OSAL_RESULT_TRUE)
 {
    <i><span style="color: #008000">// manipulate the shared data</span></i>
    ...

    <i><span style="color: #008000">// unlock the mutex</span></i>
    <a href="00658.html" target="topic">OSAL_MUTEX_Unlock</a>(&amp;mutexData);
 }</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00626.html" target="topic">OSAL Library Help</a> &gt; <a href="00635.html" target="topic">Library Interface</a> &gt; b) Mutex Functions &gt; <a href="00657.html" target="topic">OSAL_MUTEX_Lock Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00656.html" target="topic">Previous</a> | <a href="00635.html" target="topic">Up</a> | <a href="00658.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: OSAL_MUTEX_Lock@OSAL_MUTEX_HANDLE_TYPE*@uint16_t Topic Title: OSAL_MUTEX_Lock Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>